home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3c / catopen.z / catopen
Encoding:
Text File  |  2002-10-03  |  10.4 KB  |  198 lines
  1.  
  2.  
  3.  
  4. ccccaaaattttooooppppeeeennnn((((3333CCCC))))                                                        ccccaaaattttooooppppeeeennnn((((3333CCCC))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn, _cccc_aaaa_tttt_cccc_llll_oooo_ssss_eeee - open/close a message catalogue
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_nnnn_llll______tttt_yyyy_pppp_eeee_ssss_...._hhhh_>>>>
  13.  
  14.      _nnnn_llll______cccc_aaaa_tttt_dddd _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn _((((_cccc_oooo_nnnn_ssss_tttt _cccc_hhhh_aaaa_rrrr _****_nnnn_aaaa_mmmm_eeee_,,,, _iiii_nnnn_tttt _oooo_ffff_llll_aaaa_gggg_))))_;;;;
  15.  
  16.      _iiii_nnnn_tttt _cccc_aaaa_tttt_cccc_llll_oooo_ssss_eeee _((((_nnnn_llll______cccc_aaaa_tttt_dddd _cccc_aaaa_tttt_dddd_))))_;;;;
  17.  
  18. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.      _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn opens a message catalogue and returns a catalogue descriptor.
  20.      _n_a_m_e specifies the name of the message catalogue to be opened.  If _n_a_m_e
  21.      contains a ``/'' then _n_a_m_e specifies a pathname for the message
  22.      catalogue.  Otherwise, the environment variable _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH is used.  If
  23.      _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH does not exist in the environment, or if a message catalogue
  24.      cannot be opened in any of the paths specified by _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH, then the
  25.      default path is used [see _nnnn_llll______tttt_yyyy_pppp_eeee_ssss(5)].
  26.  
  27.      The names of message catalogues, and their location in the filestore, can
  28.      vary from one system to another.  Individual applications can choose to
  29.      name or locate message catalogues according to their own special needs.
  30.      A mechanism is therefore required to specify where the catalogue resides.
  31.  
  32.      The _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH variable provides both the location of message catalogues, in
  33.      the form of a search path, and the naming conventions associated with
  34.      message catalogue files.  For example:
  35.  
  36.           _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH_====_////_nnnn_llll_ssss_llll_iiii_bbbb_////_%%%%_LLLL_////_%%%%_NNNN_...._cccc_aaaa_tttt_::::_////_nnnn_llll_ssss_llll_iiii_bbbb_////_%%%%_NNNN_////_%%%%_LLLL
  37.  
  38.      The metacharacter _%%%% introduces a substitution field, where _%%%%_LLLL substitutes
  39.      the current setting of the _LLLL_AAAA_NNNN_GGGG environment variable if _o_f_l_a_g is 0 or the
  40.      current setting of the _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS category if _o_f_l_a_g is _NNNN_LLLL______CCCC_AAAA_TTTT______LLLL_OOOO_CCCC_AAAA_LLLL_EEEE
  41.      (see following section), and _%%%%_NNNN substitutes the value of the _n_a_m_e
  42.      parameter passed to _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn.  Thus, in the above example, if _o_f_l_a_g is 0,
  43.      _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn will search in _////_nnnn_llll_ssss_llll_iiii_bbbb_////_$$$$_LLLL_AAAA_NNNN_GGGG_////_n_a_m_e_...._cccc_aaaa_tttt, then in
  44.      _////_nnnn_llll_ssss_llll_iiii_bbbb_////_n_a_m_e_////_$$$$_LLLL_AAAA_NNNN_GGGG, for the required message catalogue.
  45.  
  46.      _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH will normally be set up on a system wide basis (e.g., in
  47.      _////_eeee_tttt_cccc_////_pppp_rrrr_oooo_ffff_iiii_llll_eeee) and thus makes the location and naming conventions
  48.      associated with message catalogues transparent to both programs and
  49.      users.
  50.  
  51.      Security dictates that _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn does not honor the _NNNN_LLLL_SSSS_PPPP_AAAA_TTTT_HHHH environment
  52.      variable for setuid and setgid programs.
  53.  
  54.      The full set of metacharacters is:
  55.  
  56.           _%%%%_NNNN   The value of the name parameter passed to _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ccccaaaattttooooppppeeeennnn((((3333CCCC))))                                                        ccccaaaattttooooppppeeeennnn((((3333CCCC))))
  71.  
  72.  
  73.  
  74.           _%%%%_LLLL   The value of _LLLL_AAAA_NNNN_GGGG environment variable if _o_f_l_a_g is 0.  The
  75.                value of _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS category if _o_f_l_a_g is _NNNN_LLLL______CCCC_AAAA_TTTT______LLLL_OOOO_CCCC_AAAA_LLLL_EEEE.
  76.  
  77.           _%%%%_llll   The value of the language element of _LLLL_AAAA_NNNN_GGGG environment variable
  78.                if _o_f_l_a_g is 0.  The value of the language element of
  79.                _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS category if _o_f_l_a_g is _NNNN_LLLL______CCCC_AAAA_TTTT______LLLL_OOOO_CCCC_AAAA_LLLL_EEEE.
  80.  
  81.           _%%%%_tttt   The value of the territory element of _LLLL_AAAA_NNNN_GGGG environment variable
  82.                if _o_f_l_a_g is 0.  The value of the territory element of
  83.                _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS category if _o_f_l_a_g is _NNNN_LLLL______CCCC_AAAA_TTTT______LLLL_OOOO_CCCC_AAAA_LLLL_EEEE.
  84.  
  85.           _%%%%_cccc   The value of the codeset element of _LLLL_AAAA_NNNN_GGGG environment variable
  86.                if _o_f_l_a_g is 0.  The value of the codeset element of _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS
  87.                category if _o_f_l_a_g is _NNNN_LLLL______CCCC_AAAA_TTTT______LLLL_OOOO_CCCC_AAAA_LLLL_EEEE.
  88.  
  89.           _%%%%_%%%%   A single %.
  90.  
  91.      The _LLLL_AAAA_NNNN_GGGG environment variable provides the ability to specify the user's
  92.      requirements for native languages, local customs, and character set, as
  93.      an ASCII string in the form
  94.           _LLLL_AAAA_NNNN_GGGG_====_llll_aaaa_nnnn_gggg_uuuu_aaaa_gggg_eeee_[[[[______tttt_eeee_rrrr_rrrr_iiii_tttt_oooo_rrrr_yyyy_[[[[_...._cccc_oooo_dddd_eeee_ssss_eeee_tttt_]]]]_]]]]
  95.  
  96.      A user who speaks German as it is spoken in Austria and has a terminal
  97.      which operates in ISO 8859/1 codeset, would want the setting of the _LLLL_AAAA_NNNN_GGGG
  98.      variable to be
  99.  
  100.           _LLLL_AAAA_NNNN_GGGG_====_DDDD_eeee______AAAA_...._8888_8888_5555_9999_1111
  101.  
  102.      With this setting it should be possible for that user to find any
  103.      relevant catalogues should they exist.
  104.  
  105.      If it still can't find the catalogue file, then the default path as
  106.      defined in _nnnn_llll______tttt_yyyy_pppp_eeee_ssss is used.
  107.  
  108.      _o_f_l_a_g is used to locate the catalogue file. If _o_f_l_a_g is 0, the _LLLL_AAAA_NNNN_GGGG
  109.      environment variable is used to locate it. If _o_f_l_a_g is set to
  110.      _NNNN_LLLL______CCCC_AAAA_TTTT______LLLL_OOOO_CCCC_AAAA_LLLL_EEEE, the _LLLL_CCCC______MMMM_EEEE_SSSS_SSSS_AAAA_GGGG_EEEE_SSSS category is used to locate the catalogue
  111.      file.  The results of setting this field to any other value are
  112.      undefined.
  113.  
  114.      _cccc_aaaa_tttt_cccc_llll_oooo_ssss_eeee closes the message catalogue identified by _c_a_t_d.
  115.  
  116. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  117.      _cccc_aaaa_tttt_gggg_eeee_tttt_ssss(3C), _ssss_eeee_tttt_llll_oooo_cccc_aaaa_llll_eeee(3C), _eeee_nnnn_vvvv_iiii_rrrr_oooo_nnnn(5), _nnnn_llll______tttt_yyyy_pppp_eeee_ssss(5).
  118.  
  119. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  120.      If successful, _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn returns a message catalogue descriptor for use in
  121.      subsequent calls to _cccc_aaaa_tttt_gggg_eeee_tttt_ssss and _cccc_aaaa_tttt_cccc_llll_oooo_ssss_eeee.  Otherwise _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn returns
  122.      _((((_nnnn_llll______cccc_aaaa_tttt_dddd_)))) _----_1111.
  123.  
  124.  
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135. ccccaaaattttooooppppeeeennnn((((3333CCCC))))                                                        ccccaaaattttooooppppeeeennnn((((3333CCCC))))
  136.  
  137.  
  138.  
  139.      _cccc_aaaa_tttt_cccc_llll_oooo_ssss_eeee returns 0 if successful, otherwise -1.
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                                                         PPPPaaaaggggeeee 3333
  195.  
  196.  
  197.  
  198.